Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add properties as required for ipampool and body as required for put … #30701

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Add properties as required for ipampool and body as required for put … #30701

wants to merge 3 commits into from

Conversation

sssharma24
Copy link
Member

@sssharma24 sssharma24 commented Sep 24, 2024 •
edited
Loading

…ipampool

ARM (Control Plane) API Specification Update Pull Request

Tip

Overwhelmed by all this guidance? See the Getting help section at the bottom of this PR description.

PR review workflow diagram

Please understand this diagram before proceeding. It explains how to get your PR approved & merged.

spec_pr_review_workflow_diagram

Purpose of this PR

What's the purpose of this PR? Check the specific option that applies. This is mandatory!

  • New resource provider.
  • New API version for an existing resource provider. (If API spec is not defined in TypeSpec, the PR should have been created in adherence to OpenAPI specs PR creation guidance).
  • Update existing version for a new feature. (This is applicable only when you are revising a private preview API version.)
  • Update existing version to fix OpenAPI spec quality issues in S360.
  • Convert existing OpenAPI spec to TypeSpec spec (do not combine this with implementing changes for a new API version).
  • Other, please clarify:
    • edit this with your clarification

Due diligence checklist

To merge this PR, you must go through the following checklist and confirm you understood
and followed the instructions by checking all the boxes:

  • I confirm this PR is modifying Azure Resource Manager (ARM) related specifications, and not data plane related specifications.
  • I have reviewed following Resource Provider guidelines, including
    ARM resource provider contract and
    REST guidelines (estimated time: 4 hours).
    I understand this is required before I can proceed to the diagram Step 2, "ARM API changes review", for this PR.

Additional information

Viewing API changes

For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the Generated ApiView comment added to this PR. You can use ApiView to show API versions diff.

Suppressing failures

If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
suppressions guide to get approval.

Getting help

  • First, please carefully read through this PR description, from top to bottom. Please fill out the Purpose of this PR and Due diligence checklist.
  • If you don't have permissions to remove or add labels to the PR, request write access per aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositories
  • To understand what you must do next to merge this PR, see the Next Steps to Merge comment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.
  • For guidance on fixing this PR CI check failures, see the hyperlinks provided in given failure
    and https://aka.ms/ci-fix.
  • For help with ARM review (PR workflow diagram Step 2), see https://aka.ms/azsdk/pr-arm-review.
  • If the PR CI checks appear to be stuck in queued state, please add a comment with contents /azp run.
    This should result in a new comment denoting a PR validation pipeline has started and the checks should be updated after few minutes.
  • If the help provided by the previous points is not enough, post to https://aka.ms/azsdk/support/specreview-channel and link to this PR.

@openapi-pipeline-app openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Sep 24, 2024 •
edited
Loading

Next Steps to Merge

Next steps that must be taken to merge this PR:
  • ❌ This is the public specs repo main branch which is not intended for iterative development.
    You must acknowledge that you understand that after this PR is merged, you won't be able to stop your changes from being published to Azure customers.
    If this is what you intend, add PublishToCustomers label to your PR.
    Otherwise, retarget this PR onto a feature branch, i.e. with prefix release- (see aka.ms/azsdk/api-versions#release--branches).
  • ❌ This PR is in purview of the ARM review (label: ARMReview). This PR must get ARMSignedOff label from an ARM reviewer.
    This PR is not ready for ARM review (label: NotReadyForARMReview). This PR will not be reviewed by ARM until relevant problems are fixed. Consult the rest of this Next Steps to Merge comment for details.
    Once the blocking problems are addressed, add to the PR a comment with contents /azp run. Automation will re-evaluate this PR and if everything looks good, it will add WaitForARMFeedback label which will put this PR on the ARM review queue.
    For details of the ARM review, see aka.ms/azsdk/pr-arm-review
  • ❌ This PR is NotReadyForARMReview because it has the VersioningReviewRequired label.
  • ❌ This PR has at least one change violating Azure versioning policy (label: VersioningReviewRequired).
    To unblock this PR, either a) introduce a new API version with these changes instead of modifying an existing API version, or b) follow the process at aka.ms/brch.
  • ❌ The required check named Swagger BreakingChange has failed. To unblock this PR, follow the process at aka.ms/brch.

@openapi-pipeline-app openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Sep 24, 2024 •
edited
Loading

Generated ApiView

Language Package Name ApiView Link
Go sdk/resourcemanager/network/armnetwork https://apiview.dev/Assemblies/Review/1b263a329090477991c0a7b7b0ae21d7?revisionId=6e454809e76e47f4920d469c2dbb89ad
Java azure-resourcemanager-network-generated https://apiview.dev/Assemblies/Review/d496e631581f47bcab5c961219fc2258?revisionId=648563b286094204831f7ccc3e4ec75d
JavaScript @azure/arm-network https://apiview.dev/Assemblies/Review/c13fd66ecbcc4c2a9995c8a1f4187240?revisionId=83b0ad4bd636441bbd5bc610649053d9
.Net Azure.ResourceManager.Network There is no API change compared with the previous version
Swagger Microsoft.Network https://apiview.dev/Assemblies/Review/9a91f46aa0a846acaae91aba821517fb?revisionId=700c5c06d50f4c9983c77ccfdc1fe304

@sssharma24
Copy link
Member Author

small update that has already been signed off in the stable #30560

This was referenced Sep 24, 2024
Draft
Draft
Draft
Draft
@AzureRestAPISpecReview AzureRestAPISpecReview added ARMReview NotReadyForARMReview resource-manager VersioningReviewRequired <valid label in PR review process>add this label when versioning review is required labels Sep 24, 2024
@azure-sdk azure-sdk mentioned this pull request Sep 24, 2024
Draft
@sssharma24 sssharma24 added WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required and removed NotReadyForARMReview labels Sep 25, 2024
@ms-bogdan-rotaru
Copy link

This PR has at least one change violating Azure versioning policy (label: VersioningReviewRequired).
To unblock this PR, either a) introduce a new API version with these changes instead of modifying an existing API version, or b) follow the process at aka.ms/brch.

@ms-bogdan-rotaru ms-bogdan-rotaru added the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Sep 26, 2024
@openapi-pipeline-app openapi-pipeline-app bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Sep 26, 2024
@sssharma24 sssharma24 added BreakingChange-Approved-BugFix Changes are to correct the REST API definition to correctly describe service behavior and removed ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review labels Sep 26, 2024
@openapi-pipeline-app openapi-pipeline-app bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Sep 26, 2024
@sssharma24
Copy link
Member Author

This PR has at least one change violating Azure versioning policy (label: VersioningReviewRequired). To unblock this PR, either a) introduce a new API version with these changes instead of modifying an existing API version, or b) follow the process at aka.ms/brch.

I don't think this should be an issue since we don't have customers or any tools for this yet and it's basically a bug fix. The property was always required we only missed it in the swagger

@ms-bogdan-rotaru
Copy link

Please fix the errors reported by Swagger ModelValidation check.

@ms-bogdan-rotaru ms-bogdan-rotaru added the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Sep 27, 2024
@openapi-pipeline-app openapi-pipeline-app bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Sep 27, 2024
@microsoft-github-policy-service microsoft-github-policy-service bot added no-recent-activity There has been no recent activity on this issue. labels Oct 14, 2024
@sssharma24 sssharma24 reopened this Oct 29, 2024
@microsoft-github-policy-service microsoft-github-policy-service bot removed the no-recent-activity There has been no recent activity on this issue. label Oct 29, 2024
@sssharma24 sssharma24 added WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required and removed ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review labels Oct 29, 2024
@AzureRestAPISpecReview AzureRestAPISpecReview added NotReadyForARMReview ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test and removed BreakingChange-Approved-BugFix Changes are to correct the REST API definition to correctly describe service behavior WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Oct 29, 2024
@sssharma24 sssharma24 added WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required and removed NotReadyForARMReview labels Oct 29, 2024
@sssharma24
Copy link
Member Author

Please fix the errors reported by Swagger ModelValidation check.

I have fixed the errors

@sssharma24
Copy link
Member Author

@ms-bogdan-rotaru could you please review now?

@AzureRestAPISpecReview AzureRestAPISpecReview added NotReadyForARMReview and removed WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Oct 29, 2024
@azure-sdk azure-sdk mentioned this pull request Oct 29, 2024
Draft
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kamboj-prjwl kamboj-prjwl Awaiting requested review from kamboj-prjwl kamboj-prjwl is a code owner

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
ARMReview Network NotReadyForARMReview ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test resource-manager VersioningReviewRequired <valid label in PR review process>add this label when versioning review is required
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@sssharma24 @ms-bogdan-rotaru @AzureRestAPISpecReview